docs: Add integration doc for inactive validators #2133
Conversation
WalkthroughWalkthroughThe recent changes enable inactive validators to participate in validating transactions on consumer chains within the Interchain Security framework. This is achieved by adjusting parameters to increase validator participation while maintaining the integrity of the consensus process. The documentation clarifies the roles of bonded and active validators, detailing their eligibility for rewards and governance involvement. Changes
Possibly related issues
Recent review detailsConfiguration used: .coderabbit.yml Files selected for processing (1)
Additional context usedLanguageTool
Markdownlint
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (invoked as PR comments)
Additionally, you can add CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
Outside diff range, codebase verification and nitpick comments (4)
docs/docs/upgrading/integrating_inactive_validators.md (4)
7-7: Refine for Conciseness.The phrase "outside of" is redundant. Consider using "outside" for conciseness.
- validators outside of the active set + validators outside the active setTools
LanguageTool
[style] ~7-~7: This phrase is redundant. Consider using “outside”.
Context: ...ing-inactive-validators.md), validators outside of the active set on the provider chain ca...(OUTSIDE_OF)
19-23: Adjust Heading Level.The heading level for
/cosmos/staking/v1beta1/poolshould be adjusted to H2 for consistency.- ### `/cosmos/staking/v1beta1/pool` + ## `/cosmos/staking/v1beta1/pool`Tools
Markdownlint
21-21: Expected: h2; Actual: h3
Heading levels should only increment by one level at a time(MD001, heading-increment)
27-27: Format Bare URL as a Link.The bare URL should be formatted as a hyperlink for better readability.
- query the validator set from Tendermint (https://docs.cometbft.com/v0.37/rpc/#/Info/validators) + query the validator set from Tendermint [here](https://docs.cometbft.com/v0.37/rpc/#/Info/validators)Tools
Markdownlint
27-27: null
Bare URL used(MD034, no-bare-urls)
27-27: null
Files should end with a single newline character(MD047, single-trailing-newline)
27-27: Add Newline at End of File.Ensure the file ends with a single newline character for consistency with Markdown standards.
+Tools
Markdownlint
27-27: null
Bare URL used(MD034, no-bare-urls)
27-27: null
Files should end with a single newline character(MD047, single-trailing-newline)
|
The right side of the page looks peculiar because it just shows the Having this under |
|
Thanks for the feedback, I have made an extra section called "Integrators Guide" |
There was a problem hiding this comment.
Actionable comments posted: 0
Outside diff range, codebase verification and nitpick comments (3)
docs/docs/integrators/integrating_inactive_validators.md (3)
7-7: Refine phrasing for clarity.Consider simplifying the phrase "outside of the active set" to "outside the active set" for clarity.
- validators outside of the active set + validators outside the active setTools
LanguageTool
[style] ~7-~7: This phrase is redundant. Consider using “outside”.
Context: ...ing-inactive-validators.md), validators outside of the active set on the provider chain ca...(OUTSIDE_OF)
27-27: Avoid using bare URLs.Consider embedding the URL within a Markdown link for better readability.
- query the validator set from Tendermint (https://docs.cometbft.com/v0.37/rpc/#/Info/validators or `query comet-validator-set [height]`) + query the validator set from Tendermint ([Tendermint RPC](https://docs.cometbft.com/v0.37/rpc/#/Info/validators) or `query comet-validator-set [height]`)Tools
Markdownlint
27-27: null
Bare URL used(MD034, no-bare-urls)
27-27: null
Files should end with a single newline character(MD047, single-trailing-newline)
27-27: Ensure the file ends with a single newline character.Add a newline character at the end of the file to adhere to Markdown best practices.
+Tools
Markdownlint
27-27: null
Bare URL used(MD034, no-bare-urls)
27-27: null
Files should end with a single newline character(MD047, single-trailing-newline)
There was a problem hiding this comment.
Actionable comments posted: 0
Outside diff range, codebase verification and nitpick comments (3)
docs/docs/integrators/integrating_inactive_validators.md (3)
7-7: Consider using “outside” instead of “outside of.”This phrase is redundant. Consider simplifying it for clarity.
- validators outside of the active set + validators outside the active setTools
LanguageTool
[style] ~7-~7: This phrase is redundant. Consider using “outside”.
Context: ...ing-inactive-validators.md), validators outside of the active set on the provider chain ca...(OUTSIDE_OF)
27-27: Format the bare URL properly.Consider using Markdown syntax to improve readability.
- query the validator set from Tendermint (https://docs.cometbft.com/v0.37/rpc/#/Info/validators or `query comet-validator-set [height]`) + query the validator set from Tendermint ([Tendermint RPC](https://docs.cometbft.com/v0.37/rpc/#/Info/validators) or `query comet-validator-set [height]`)Tools
Markdownlint
27-27: null
Bare URL used(MD034, no-bare-urls)
27-27: null
Files should end with a single newline character(MD047, single-trailing-newline)
27-27: Ensure file ends with a single newline character.Files should end with a single newline character for consistency.
- query comet-validator-set [height]`), which will return the set of all *active* validators. + query comet-validator-set [height]`), which will return the set of all *active* validators.\nTools
Markdownlint
27-27: null
Bare URL used(MD034, no-bare-urls)
27-27: null
Files should end with a single newline character(MD047, single-trailing-newline)
Description
Closes: #XXXX
Improve docs for inactive vals, aimed at integrators.
We will link to these as part of an outreach to block explorers, wallets, staking platforms, and other integrators.
Please review the docs locally to see how this looks on the web:
make build-docs-localIn particular, interested in opinions on where this page should be (is it ok under
Upgrading, should there be an extra section calledIntegration; other ideas on where it could be?)Author Checklist
All items are required. Please add a note to the item if the item is not applicable and
please add links to any relevant follow up issues.
I have...
docs:prefix in the PR titleReviewers Checklist
All items are required. Please add a note if the item is not applicable and please add
your handle next to the items reviewed if you only reviewed selected items.
I have...
docs:prefix in the PR titlemake build-docs)Summary by CodeRabbit
Summary by CodeRabbit